org.eclipse.vtp.framework.engine
Class ObserverDescriptor

java.lang.Object
  org.eclipse.vtp.framework.engine.ObserverDescriptor

public final class ObserverDescriptor
extends java.lang.Object

An object that describes an observer that can be bound to actions.

Author:

Lonnie Pryor

Constructor Summary

ObserverDescriptor(java.lang.String id, java.lang.String name, java.lang.Class type, boolean blocking)
Creates a new ObserverDescriptor.

Method Summary

java.lang.String	getId() Returns the ID of this service.
java.lang.String	getName() Returns the name of this service.
java.lang.Class	getType() Returns the type of this service.
boolean	isBlocking() Returns true if this observer is blocking.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ObserverDescriptor

public ObserverDescriptor(java.lang.String id,
                          java.lang.String name,
                          java.lang.Class type,
                          boolean blocking)
                   throws java.lang.IllegalArgumentException,
                          java.lang.NullPointerException

Creates a new ObserverDescriptor.

Parameters:

id - The ID of this observer.

name - The name of this observer.

type - The type of this observer.

blocking - True if this observer is blocking.

Throws:

java.lang.IllegalArgumentException - If the supplied ID is empty.

java.lang.IllegalArgumentException - If the supplied name is empty.

java.lang.IllegalArgumentException - If the supplied event is not one of before or after.

java.lang.IllegalArgumentException - If the supplied type is not a public, concrete class with at least one public constructor or is not assignable to Runnable.

java.lang.NullPointerException - If the supplied ID is null.

java.lang.NullPointerException - If the supplied name is null.

java.lang.NullPointerException - If the supplied event is null.

java.lang.NullPointerException - If the supplied type is null.

Method Detail

getId

public java.lang.String getId()

Returns the ID of this service.

Returns:

The ID of this service.

getName

public java.lang.String getName()

Returns the name of this service.

Returns:

The name of this service.

getType

public java.lang.Class getType()

Returns the type of this service.

Returns:

The type of this service.

isBlocking

public boolean isBlocking()

Returns true if this observer is blocking.

Returns:

True if this observer is blocking.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object